<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketclient;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.net.InetAddress;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.HashMap;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    /**<a name="line.7"></a>
<FONT color="green">008</FONT>     * Contains all session data concerning the server. Also contains a session data container for external use only. External users can utilize<a name="line.8"></a>
<FONT color="green">009</FONT>     * this container to store server related (session) data for the duration of the connection.<a name="line.9"></a>
<FONT color="green">010</FONT>     * &lt;p&gt;<a name="line.10"></a>
<FONT color="green">011</FONT>     * Only the server's id and the session data container is exposed publicly. The server id is determined during construction so that even<a name="line.11"></a>
<FONT color="green">012</FONT>     * when the connection is lost, external users can still access the server's id without connection exceptions.<a name="line.12"></a>
<FONT color="green">013</FONT>     * &lt;p&gt;<a name="line.13"></a>
<FONT color="green">014</FONT>     * Instances of this classes act as unique identifiers for client sockets, doing so allows executable message objects to access the server's<a name="line.14"></a>
<FONT color="green">015</FONT>     * session data without needing the Socket or InetAddress to identify the client.<a name="line.15"></a>
<FONT color="green">016</FONT>     * &lt;p&gt;<a name="line.16"></a>
<FONT color="green">017</FONT>     * This context keeps information about the server which may remain accessible even when the client or server has disconnected.<a name="line.17"></a>
<FONT color="green">018</FONT>     * <a name="line.18"></a>
<FONT color="green">019</FONT>     * @author Benny Bottema<a name="line.19"></a>
<FONT color="green">020</FONT>     * @since 1.0<a name="line.20"></a>
<FONT color="green">021</FONT>     */<a name="line.21"></a>
<FONT color="green">022</FONT>    public class ServerContext {<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>            /**<a name="line.24"></a>
<FONT color="green">025</FONT>             * Server to which this context is dedicated to. Used to read from and write to.<a name="line.25"></a>
<FONT color="green">026</FONT>             */<a name="line.26"></a>
<FONT color="green">027</FONT>            private final ServerEndpoint serverEndpoint;<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>            /**<a name="line.29"></a>
<FONT color="green">030</FONT>             * Server id to which context is dedicated to. Acquired from {@link #serverInetAddress}. Kept separate for when the socket has been<a name="line.30"></a>
<FONT color="green">031</FONT>             * closed already and the user still wants to know the original server id.<a name="line.31"></a>
<FONT color="green">032</FONT>             */<a name="line.32"></a>
<FONT color="green">033</FONT>            private final InetAddress serverInetAddress;<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>            /**<a name="line.35"></a>
<FONT color="green">036</FONT>             * Flag that indicated whether the client has sent a 'Bye Bye' notification to gracefully close the connection, or when the connection<a name="line.36"></a>
<FONT color="green">037</FONT>             * was lost somehow.<a name="line.37"></a>
<FONT color="green">038</FONT>             */<a name="line.38"></a>
<FONT color="green">039</FONT>            private volatile boolean serverSaidByeBye;<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>            /**<a name="line.41"></a>
<FONT color="green">042</FONT>             * A session scoped data container for external use only. Users can access this container to store temporary data concerning the current<a name="line.42"></a>
<FONT color="green">043</FONT>             * server connection, until the connection is lost and the context destroyed.<a name="line.43"></a>
<FONT color="green">044</FONT>             */<a name="line.44"></a>
<FONT color="green">045</FONT>            private final Map&lt;Object, Object&gt; sessionData = new HashMap&lt;Object, Object&gt;();<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>            /**<a name="line.47"></a>
<FONT color="green">048</FONT>             * Stores the given server endpoint and saves its {@link InetAddress} for later use (in case the endpoint is being closed and we lose<a name="line.48"></a>
<FONT color="green">049</FONT>             * the ability the query for the {@link InetAddress}).<a name="line.49"></a>
<FONT color="green">050</FONT>             * <a name="line.50"></a>
<FONT color="green">051</FONT>             * @param serverEndpoint The server with which we have established a communication channel.<a name="line.51"></a>
<FONT color="green">052</FONT>             */<a name="line.52"></a>
<FONT color="green">053</FONT>            public ServerContext(final ServerEndpoint serverEndpoint) {<a name="line.53"></a>
<FONT color="green">054</FONT>                    this.serverEndpoint = serverEndpoint;<a name="line.54"></a>
<FONT color="green">055</FONT>                    serverInetAddress = serverEndpoint.getInetAddress();<a name="line.55"></a>
<FONT color="green">056</FONT>            }<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>            /**<a name="line.58"></a>
<FONT color="green">059</FONT>             * {@inheritDoc}<a name="line.59"></a>
<FONT color="green">060</FONT>             */<a name="line.60"></a>
<FONT color="green">061</FONT>            @Override<a name="line.61"></a>
<FONT color="green">062</FONT>            public String toString() {<a name="line.62"></a>
<FONT color="green">063</FONT>                    return String.valueOf(serverEndpoint.getInetAddress());<a name="line.63"></a>
<FONT color="green">064</FONT>            }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>            /**<a name="line.66"></a>
<FONT color="green">067</FONT>             * @return {@link #serverEndpoint}.<a name="line.67"></a>
<FONT color="green">068</FONT>             */<a name="line.68"></a>
<FONT color="green">069</FONT>            final ServerEndpoint getServerEndpoint() {<a name="line.69"></a>
<FONT color="green">070</FONT>                    return serverEndpoint;<a name="line.70"></a>
<FONT color="green">071</FONT>            }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>            /**<a name="line.73"></a>
<FONT color="green">074</FONT>             * @return {@link #serverInetAddress}<a name="line.74"></a>
<FONT color="green">075</FONT>             */<a name="line.75"></a>
<FONT color="green">076</FONT>            public InetAddress getServerInetAddress() {<a name="line.76"></a>
<FONT color="green">077</FONT>                    return serverInetAddress;<a name="line.77"></a>
<FONT color="green">078</FONT>            }<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>            /**<a name="line.80"></a>
<FONT color="green">081</FONT>             * @return {@link #sessionData}<a name="line.81"></a>
<FONT color="green">082</FONT>             */<a name="line.82"></a>
<FONT color="green">083</FONT>            public Map&lt;Object, Object&gt; getSessionData() {<a name="line.83"></a>
<FONT color="green">084</FONT>                    return sessionData;<a name="line.84"></a>
<FONT color="green">085</FONT>            }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>            /**<a name="line.87"></a>
<FONT color="green">088</FONT>             * @return {@link #serverSaidByeBye}<a name="line.88"></a>
<FONT color="green">089</FONT>             */<a name="line.89"></a>
<FONT color="green">090</FONT>            final boolean isServerSaidByeBye() {<a name="line.90"></a>
<FONT color="green">091</FONT>                    return serverSaidByeBye;<a name="line.91"></a>
<FONT color="green">092</FONT>            }<a name="line.92"></a>
<FONT color="green">093</FONT>    <a name="line.93"></a>
<FONT color="green">094</FONT>            final void setServerSaidByeBye(final boolean serverSaidByeBye) {<a name="line.94"></a>
<FONT color="green">095</FONT>                    this.serverSaidByeBye = serverSaidByeBye;<a name="line.95"></a>
<FONT color="green">096</FONT>            }<a name="line.96"></a>
<FONT color="green">097</FONT>    }<a name="line.97"></a>




























































</PRE>
</BODY>
</HTML>
